#pragma once

#if defined(MAVLINK_USE_CXX_NAMESPACE)
namespace mavlink {
#elif defined(__cplusplus)
extern "C" {
#endif

// Visual Studio versions before 2010 don't have stdint.h, so we just error out.
#if (defined _MSC_VER) && (_MSC_VER < 1600)
#error "The C-MAVLink implementation requires Visual Studio 2010 or greater"
#endif

#include <stdint.h>

/**
 *
 *  CALCULATE THE CHECKSUM
 *
 */

#define X25_INIT_CRC 0xffff
#define X25_VALIDATE_CRC 0xf0b8

#ifndef HAVE_CRC_ACCUMULATE
/**
 * @brief Accumulate the CRC16_MCRF4XX checksum by adding one char at a time.
 *
 * The checksum function adds the hash of one char at a time to the
 * 16 bit checksum (uint16_t).
 *
 * @param data new char to hash
 * @param crcAccum the already accumulated checksum
 **/
// 把一个字节 data 累加到 CRC 累积值 crcAccum 里；
//   - *crcAccum 是传指针，函数内部直接修改外面的累积值；
//   - 每收到一个字节，经过一套巧妙的异或 + 移位处理，把字节的特征混进 CRC 里，确保最终的 CRC 值能精准校验数据完整性；
static inline void crc_accumulate(uint8_t data, uint16_t *crcAccum)
{
        // 临时变量 tmp，用来存中间计算结果；
        uint8_t tmp;

        // *crcAccum & 0xff ：取出 crc 累积值的低 8 位；
        // data ^ (...) ：把当前的 data 和这个低 8 位做异或；
        tmp = data ^ (uint8_t)(*crcAccum &0xff);
        // tmp 左移 4 位，再和自己异或一次；
        // 增加数据混合度，让 CRC 变化得更复杂，不容易冲突；
        tmp ^= (tmp<<4);
        // 更新 CRC 累积值；
        //   - *crcAccum >> 8：先把当前 CRC 右移 8 位，也就是丢掉已经用过的低 8 位；
        //   - tmp << 8：临时值 tmp 左移 8 位，加到 CRC 高位；
        //   - tmp << 3：tmp 左移 3 位，加到中间位；
        //   - tmp >> 4：tmp 右移 4 位，加到低位；
        // 综合考虑了高位、中位、低位，增加扰动，最后异或出一个新的 CRC 累积值；
        *crcAccum = (*crcAccum>>8) ^ (tmp<<8) ^ (tmp <<3) ^ (tmp>>4);
}
#endif


/**
 * @brief Initialize the buffer for the MCRF4XX CRC16
 *
 * @param crcAccum the 16 bit MCRF4XX CRC16
 */
static inline void crc_init(uint16_t* crcAccum)
{
        *crcAccum = X25_INIT_CRC;
}


/**
 * @brief Calculates the CRC16_MCRF4XX checksum on a byte buffer
 *
 * @param  pBuffer buffer containing the byte array to hash
 * @param  length  length of the byte array
 * @return the checksum over the buffer bytes
 **/
static inline uint16_t crc_calculate(const uint8_t* pBuffer, uint16_t length)
{
        uint16_t crcTmp;
        crc_init(&crcTmp);
	while (length--) {
                crc_accumulate(*pBuffer++, &crcTmp);
        }
        return crcTmp;
}


/**
 * @brief Accumulate the MCRF4XX CRC16 by adding an array of bytes
 *
 * The checksum function adds the hash of one char at a time to the
 * 16 bit checksum (uint16_t).
 *
 * @param data new bytes to hash
 * @param crcAccum the already accumulated checksum
 **/
static inline void crc_accumulate_buffer(uint16_t *crcAccum, const char *pBuffer, uint16_t length)
{
	const uint8_t *p = (const uint8_t *)pBuffer;
	while (length--) {
                crc_accumulate(*p++, crcAccum);
        }
}

#if defined(MAVLINK_USE_CXX_NAMESPACE) || defined(__cplusplus)
}
#endif
